home *** CD-ROM | disk | FTP | other *** search
/ BCI NET 2 / BCI NET 2.iso / archives / utilities / misc / i2sb_1.5.lha / I2SB-English.doc next >
Encoding:
Text File  |  1995-03-16  |  5.9 KB  |  201 lines
  1.  -------------------------------------
  2. |         I2SB version 1.5            |
  3.  -------------------------------------
  4.  
  5.  
  6. Introduction
  7. ------------
  8.  
  9.  
  10. This program will only be useful for Superbase Users who download things
  11. from Aminet (or who use Aminet CD). If you're not in that case you should
  12. close this document and erase this archive because you don't need it at all.
  13.  
  14. I2SB (for Index to SuperBase) allows you to convert a standard Aminet Index
  15. file to an ASCII file which can be used with SuperBase.
  16. I programmed it because I didn't want to use grep any more when I wanted to
  17. to search something in my Index files.
  18.  
  19. By the way, I'm a French student so excuse me for my English...
  20.  
  21.  
  22.  
  23. Installation
  24. ------------
  25.  
  26. Copy I2SB where you want. You can also put an Index file in the same
  27. directory if you want. Put also the file I2SB.Config in this directory.
  28.  
  29.  
  30.  
  31. Configuration
  32. -------------
  33.  
  34. To use I2SB, you will need one or two things :
  35.  
  36. - An Amiga (you could use it...)
  37.  
  38. - An Aminet Index : It's a standard Index with descriptions truncated to 42
  39.                     caracters (more or less).
  40.  
  41. - SuperBase
  42.  
  43. - IXEMUL.LIBRARY : It can be found on Aminet or with GCC
  44.  
  45.  
  46. I tested I2SB 1.5  on an Amiga 1200 + 6 Megs (2 Megs Chip + 4 Megs Fast) converting
  47. the Aminet Index from 10-Mar-95 (ftp.cnam.fr).
  48.  
  49.  
  50.  
  51. Manual
  52. ------
  53.  
  54.  
  55. There are two ays to launch I2SB (from CLI) :
  56.  
  57. - Type I2SB alone : If you do that you must have a file named INDEX in
  58.                     the directory you are launching I2SB from.
  59.  
  60. - Type i2sb + file name : If this file exists so I2SB will work on it.
  61.  
  62.  
  63. I2SB has a configuration file. Please note that this file is optionnal. If
  64. it's missing I2SB will use default values (they are in the demo-file). This
  65. file contains the size of the 4 first fields, one by line. Numbers smaller
  66. than 10 must be preceded by a 0. If you don't respect this rule, and/or you
  67. change the file's structure I2SB will react in a very, very strange way...
  68. If you want to know how the file is made just have a look at the one in this
  69. archive.
  70.  
  71. The program will display his work on the standard output. If you want to record
  72. conversion in a file you will have to redirect this output to a file (you must
  73. redirect output if you use SuperBase)
  74.  
  75. Example : I2SB MyOwnIndex.txt > ImportIndex
  76.  
  77.          Conversion of the file MyOwnIndex.txt in the file ImportIndex
  78.  
  79.  
  80. For SuperBase import, here are a few hints :
  81.  
  82.     - Create a new file with the following fields
  83.  
  84.  
  85.                 Name            TXT         18
  86.                 Path            TXT         11
  87.                 Size            TXT          5
  88.                 Age             TXT          3
  89.                 Description     TXT         42
  90.  
  91.     - Choose the name as unique index
  92.  
  93.     - Import ASCII data (to save disk space)
  94.  
  95.     - Wait (it could be long)
  96.  
  97. N.B. : It works with SuperBase Personnal Franch. I bought my version in 1988
  98.        and I haven't tried I2SB with a more recent one. For more details
  99.        you should read your manual.
  100.  
  101. By the way, to avoid problems, redirect output in a file located in RAM:
  102. (I2SB Index.txt > Ram:Import). It will prevent your hard disk from being
  103. damaged if the program crashes during an execution (I did not have this problem
  104. on my computer but ...)
  105.  
  106. IMPORTANT NOTE : Don't redirect output to the file you are converting. You could
  107.                  loose your Index file or damage your disk.
  108.  
  109.  
  110.  
  111. Disclaimer
  112. ----------
  113.  
  114. This piece of software has been tested on a A1200 .You use it at your
  115. own risks and I can't be responsible if it destroys your hard disk, doesn't
  116. work on your Amiga 9000 + 68095 card or has a very strange behavior
  117. if you don't use it in the right way.
  118.  
  119. Seriousely, I decline responsabilities in case of big problem caused by I2SB.
  120. Due to the algorithms I use it can't break anything IF YOU FOLLOW THE INSTRUCTIONS
  121. GIVEN IN THIS MANUAL. If there is an unclear passage , contact me.
  122.  
  123.  
  124. Distribution
  125. ------------
  126.  
  127. I2SB is FREEWARE. But I keep a copyright on it.
  128.  
  129. You can diffuse it and use it freely if the archive is kept intact
  130. and if you don't put a virus in it.
  131.  
  132. Aminet, Fred Fish and Amiga magazines are allowed to include this program
  133. in their collections. Public Domain organisations also have this authorization,
  134. if the price of the disk stays normal. France Festival Distribution WILL NEVER
  135. BE ALLOWED to diffuse I2SB.
  136.  
  137.  
  138. History
  139. -------
  140.  
  141.  
  142.     March 1995  :   Beta Version 1
  143.                     Initial release
  144.  
  145.     March 1995  :   Version 1.2
  146.                     Completly re-written program (much cleaner).
  147.                     Version not released
  148.  
  149.     March 1995  :   Version 1.3
  150.                     I2SB now works on Index files with the 'Age' column
  151.                     Warning : It is no more compatible with the Aminet IV
  152.                     Index file. If you need to work on it use the beta 1
  153.                     version.
  154.                     Version not diffused
  155.  
  156.     March 1995  :   Headers and empty lines are handled by I2SB (no need
  157.                     to edit the Index any more).
  158.                     Version not released
  159.  
  160.     March 1995  :   I2SB can be configured by an external file.
  161.  
  162.  
  163. Author
  164. ------
  165.  
  166.  
  167. I2SB has been created by the mad brain of :
  168.  
  169.             Mr Franck Anière
  170.             30, Rue Jean Bouin
  171.             93220 GAGNY
  172.  
  173.             E-Mail : aniere@massena.univ-mlv.fr
  174.                      aniere@fillmore.univ-mlv.fr
  175.                      aniere@univ-mlv.fr (if the 2 others don't work)
  176.  
  177.  
  178. You can join me for comments, critics, suggestions and bug report
  179. (Enforcer Hits are welcome, I don't have MMU!).
  180.  
  181. I would be happy to work on a converter for another Database Software.
  182. If you are interested send me a detailled description of the format
  183. used by the program for the ASCII import or a demo-version (I MEAN
  184. A LEGAL FREELY DISTRIBUABLE DEMO, NOT A CRACKED SOFTWARE).
  185.  
  186.  
  187.  
  188. Projects
  189. --------
  190.  
  191. I think I will add the following features :
  192.  
  193.         - Direct file output
  194.  
  195.         - Possibility to choose quantity of fields
  196.  
  197. And any other suggestion I will think it is interesting and makeable
  198. (After all I'm just a student and I don't have much free time !)
  199.  
  200.  
  201.